Cavern

 Cavern4D

 Cavernize

 Debug

 FilterInterfaces

 Filters

 Format

 Helpers

 QuickEQ

 Remapping

 SpecialSources

 Spoofer

 Utilities

 Virtualizer

 Atmosphere

 AudioClip3D

 AudioListener3D

  AudioQuality

  Current

  DelayTarget

  DirectLFE

  DisableUnityAudio

  GetLayoutName()

  IsSymmetric

  LFESeparation

  LFEVolume

  LimiterOnly

  ManualUpdate()

  Normalizer

  Output

  paused

  Paused

  PerformSafely(Action)

  Range

  SampleRate

  UpdateRate

  volume

  Volume

 AudioListener3DInspector

 AudioSource3D

 CavernizeRealtime

 Channel

 Clip

 Environments

 Jack

 Listener

 QualityModes

 Rolloffs

 SeatAdaptation

 Source

class AudioListener3D

The center of the listening space. AudioSource3Ds will be rendered relative to this GameObject's position.
VisibilityPublic
ExtendsMonoBehaviour

Public functions

void ManualUpdate()Manually generate one frame.

Public static functions

string GetLayoutName() Current speaker layout name in the format of <main>.<LFE>.<height>.<floor>,
or simply "Virtualization".
void PerformSafely(Action action)Invoke an action when rendering is not in progress, making non-thread-safe Cavern calls (like seeking)
safe from another thread.

Public static properties

AudioListener3D CurrentThe active AudioListener3D instance.
bool IsSymmetric True if the layout is symmetric.
float[] OutputResult of the last update. Size is [Listener.Channels.Length * UpdateRate].
bool pausedDisables any audio. Use this instead of enabling/disabling the script.
float volumeAlias for Volume.

Public variables

QualityModes AudioQualityLower qualities increase performance for many sources.
int DelayTargetMaximum audio delay, defined in this FPS value. This is the minimum frame rate required to render continuous audio.
bool DirectLFEDisable lowpass on the LFE channel.
bool DisableUnityAudioSave performance by not remapping Unity's output to the user layout and only rendering Cavern sources.
bool LFESeparationOnly mix LFE tagged sources to subwoofers.
float LFEVolumeLFE channels' volume.
bool LimiterOnlyIf active, the normalizer won't increase the volume above 100%.
float NormalizerAdaption speed of the normalizer. 0 means disabled.
bool PausedDisables any audio. Use this instead of enabling/disabling the script.
float RangeHearing distance.
int SampleRateProject sample rate (min. 44100). It's best to have all your audio clips in this sample rate for maximum performance.
int UpdateRateUpdate interval in audio samples (min. 16). Lower values mean better interpolation, but require more processing power.
float VolumeGlobal playback volume.

See also

CavernUnity DLL.Cavern.Debug.Monitor.listenerOverrideUse a different listener other than the scene's AudioListener3D.
CavernUnity DLL.Cavern.Spoofer.AudioListenerSpooferConverts a regular AudioListener to Cavern's AudioListener3D.
CavernUnity DLL.Cavern.AudioListener3D.CurrentThe active AudioListener3D instance.